Package com.cisco.pt.ipc.sim
Interface TerminalLine
- All Superinterfaces:
IPCObject
- All Known Subinterfaces:
ConsoleLine,VirtualLine
- All Known Implementing Classes:
ConsoleLineImpl,TerminalLineImpl,VirtualLineImpl
Information provided by the PKI file:
\class TerminalLine
\brief TerminalLine manages the terminal lines, virtual terminal lines, and console lines.
\example network().getDevice("Router0").getCommandLine()
- Author:
- Auto-generated
-
Method Summary
Modifier and TypeMethodDescriptionvoidenterChar(Byte ascii, SpecialChar specialChar) Information provided by the PKI file:voidenterCommand(String commandStr) Information provided by the PKI file:voidflush(int lineCount) Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:getMode()Information provided by the PKI file:getName()Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:intgetSpeed()Information provided by the PKI file:Information provided by the PKI file:getTelnetClientAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:voidInformation provided by the PKI file:voidsetSettings(int speed, String bits, Parity parity, String stopbits, FlowControl flowcontrol) Information provided by the PKI file:Methods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Method Details
-
getName
String getName()Information provided by the PKI file:
\brief Returns the name of this terminal line. \return string, the name of this terminal line.- Returns:
- String Returns a String
-
getOwnerDevice
Device getOwnerDevice()Information provided by the PKI file:
\brief Returns the owner device of this terminal line. \return Device, the device that owns this terminal line.- Returns:
- Device Returns a Device
-
getMode
String getMode()Information provided by the PKI file:
\brief Returns the mode this terminal line is in. \return string, the mode this terminal line is in.- Returns:
- String Returns a String
-
getPrompt
String getPrompt()Information provided by the PKI file:
\brief Returns the prompt of this terminal line. \return string, the prompt of this terminal line.- Returns:
- String Returns a String
-
getUserHistory
CommandHistory getUserHistory()Information provided by the PKI file:
\brief Returns the user history of this terminal line. \return CommandHistory, the CommandHistory object.- Returns:
- CommandHistory Returns a CommandHistory
-
getConfigHistory
CommandHistory getConfigHistory()Information provided by the PKI file:
\brief Returns the config history of this terminal line. \return CommandHistory, the CommandHistory object.- Returns:
- CommandHistory Returns a CommandHistory
-
getCurrentHistory
CommandHistory getCurrentHistory()Information provided by the PKI file:
\brief Returns the current history of this terminal line. \return CommandHistory, the CommandHistory object.- Returns:
- CommandHistory Returns a CommandHistory
-
getHistorySize
int getHistorySize()Information provided by the PKI file:
\brief Returns the history size. \return int, the history size.- Returns:
- int Returns a int
-
getCommandInput
String getCommandInput()Information provided by the PKI file:
\brief Returns the command input. \return string, the command input.- Returns:
- String Returns a String
-
getTelnetClientCount
int getTelnetClientCount()Information provided by the PKI file:
\brief Returns the number of telnet clients. \return int, the number of telnet clients.- Returns:
- int Returns a int
-
getTelnetClientAt
Information provided by the PKI file:
\brief Returns the telnet client at the specified index. \param index, the index of the telnet client of interest. \return TelnetClientProcess, the TelnetClientProcess object at the specified index.- Parameters:
index- Takes in a parameter of index- Returns:
- TelnetClientProcess Returns a TelnetClientProcess
-
enterCommand
Information provided by the PKI file:
\brief Enters a command to the terminal line.- Parameters:
commandStr- Takes in a parameter of commandStr
-
enterChar
Information provided by the PKI file:
\brief Enters the specified ascii or special character into the terminal. \param ascii, any ASCII character. Includes: Backspace = 8 Ctrl+C = 3 Ctrl+Z = 26 Ctrl+Shift+6 = 30 Enter = 13 Line Feed = 10 Tab = 9 Question = '?' Space = ' ' Ctrl+B = 2 Ctrl+F = 6 Ctrl+P = 16 Ctrl+N = 14 Ctrl+A = 1 Ctrl+E = 5 Ctrl+U = 21 \param SpecialChar, a special character key. Special characters: eNoChar = 0, eArrowRight = 1, eArrowLeft, eArrowUp, eArrowDown \remark If ascii is 0, then specialChar will be examined.- Parameters:
ascii- Takes in a parameter of asciispecialChar- Takes in a parameter of specialChar
-
setSettings
Information provided by the PKI file:
\brief Sets the connection settings to this terminal \param int speed, any Speed setting of either: 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 \param char bits, The number of data bits, from 5 to 8, inclusive \param Parity parity, The parity mode, even, odd, none, mark, space \param string stopbits, The stop bits, 1, 1.5, or 2 \param FlowControl flowcontrol, The flow control method, Xon/Xoff, Hardware, None- Parameters:
speed- Takes in a parameter of speedbits- Takes in a parameter of bitsparity- Takes in a parameter of paritystopbits- Takes in a parameter of stopbitsflowcontrol- Takes in a parameter of flowcontrol
-
getSpeed
int getSpeed()Information provided by the PKI file:
This function gets the baud rate.- Returns:
- int Returns a int
-
getDataBits
Byte getDataBits()Information provided by the PKI file:
This function gets the data bits.- Returns:
- Byte Returns a Byte
-
getParity
Parity getParity()Information provided by the PKI file:
\param[in] parity a parity bit value This function sets the parity bit.- Returns:
- Parity Returns a Parity
-
getStopBits
String getStopBits()Information provided by the PKI file:
This function gets the stop bits.- Returns:
- String Returns a String
-
getFlowControl
FlowControl getFlowControl()Information provided by the PKI file:
This function gets the flow control.- Returns:
- FlowControl Returns a FlowControl
-
println
Information provided by the PKI file:
\brief This function gets the flow control. \param output, the output string to be printed to terminal line- Parameters:
output- Takes in a parameter of output
-
flush
void flush(int lineCount) Information provided by the PKI file:
\brief This function remove the first number of lines in the buffer \param lineCount, the number of lines to be removed- Parameters:
lineCount- Takes in a parameter of lineCount
-